Vcenter Ovfs DeploySpec
The Vcenter Ovfs DeploySpec schema contains parameters supplied at the time the OVF deploys onto a specific host. Users must supply some required parameters, and may override other default parameters. Customization parameters are also provided for Guest OS customization.
This schema was added in vSphere API 9.0.0.0.
{
"url": "string",
"resource_pool": "string",
"folder": "string",
"name": "string",
"host_system": "string",
"network_mapping": {
"network_mapping": {
"net_type": "string",
"network": "string"
}
},
"vm_home_datastore": {
"datastore": "string"
},
"disk_provisioning": "string",
"pull_from_esx": false,
"signature_required": false,
"skip_manifest_check": false,
"power_on": false,
"custom_http_headers": {
"custom_http_headers": "string"
},
"custom_properties": {
"custom_properties": "string"
},
"source_certificate": "string",
"deployment_option": "string"
}The HTTP location of the source OVF files or OVA.
This property was added in vSphere API 9.0.0.0.
The resource pool where the VM or vApp will deploy. Currently required but in the future versions may become optional.
This property was added in vSphere API 9.0.0.0.
if missing or null or empty, the deployment will fail.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ResourcePool. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ResourcePool.
The folder where the VirtualMachine will be placed.
This property was added in vSphere API 9.0.0.0.
if missing or null or empty, the folder will be set to vmFolder in the datacenter where the resource pool is.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Folder. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Folder.
The name of the VM or vApp being deployed as specified by an OVF.
This property was added in vSphere API 9.0.0.0.
The identifier of the host being deployed to.
This property was added in vSphere API 9.0.0.0.
If missing or null, a suitable host will be picked if possible, meeting datastore and network constraints.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.
The networkMapping defines user choices for mapping of a network as specified by the OVF descriptor to a Network in the inventory.
This property was added in vSphere API 9.0.0.0.
If missing or null, no network mapping is used.
The datastore selection for VM's home directory.
This property was added in vSphere API 9.0.0.0.
The optional disk provisioning type used upon deployment. If set all the disks in the deployed OVF will have the same specified disk type (e.g., thin provisioned).
For more information see: Vcenter Ovfs DiskProvisioningType.
This property was added in vSphere API 9.0.0.0.
If missing or null, the type will be set to thick.
Use Push mode for transferring VM files to ESX. Push mode transfers files from source to ESXi, whereas in Pull mode ESX "pulls" the files directly from source. The user needs privilege VApp.PullFromUrls in vCenter to use Pull mode.
This property was added in vSphere API 9.0.0.0.
If missing or null, the default is set to Pull mode.
Require that the OVF package includes both a certificate (.cert) file and a manifest (.mf) file. The certificate file contains a vendor-supplied public key and the signature of the manifest file as signed with the vendor-supplied private key.
This property was added in vSphere API 9.0.0.0.
If missing or null, the default is set to false.
Skip manifest validation. The manifest validation involves validating format and content of the manifest file. In Push mode of deployment all SHA entries present in the manifest file are validated against SHA digest of transferred files. If value is true and manifest file is not present a warning is generated.
This property was added in vSphere API 9.0.0.0.
If missing or null, the default is set to false.
Whether to power on the deployed entity.
This property was added in vSphere API 9.0.0.0.
If missing or null, the default is set to false.
Use this optional field to specify any custom headers required by the source server, including authenticating headers.
This property was added in vSphere API 9.0.0.0.
If missing or null, no headers are used to access source.
These parameters will apply to OVF Properties to customize the guest OS after it is deployed. These parameters specify values for corresponding ovf:Property flags. Example: if ovf:Property has ovf:key="ip" and desrired value is "1.2.3.4" then an entry would be added which would map "ip" to "1.2.3.4".
This property was added in vSphere API 9.0.0.0.
If missing or null, no customization is done.
Optionally used for HTTPS source validation. The source is the location where the OVF/OVA files are located. The source server certificate in PEM format.
This property was added in vSphere API 9.0.0.0.
If missing or null, no certificate is used.
The key of the chosen deployment option. If empty, the default option is chosen. The list of available deployment options can optionally be specified in the OVF file being deployed and this key specifies which one to use for deployment from that list.
This property was added in vSphere API 9.0.0.0.